Bulk APIs
floLIVE exposes set of bulk RESTful Public APIs for external customer systems, each of which enables an action on multiple instances of a certain entity (for example, Customer, Subscriber, Plan, etc.) in a single API call.
When using the Bulk APIs, make sure you adhere to these guidelines:
- The number of instances in a single call is limited to 200.
- The Response Structure supports asynchronous commands only. The asynchronous response structure is identical to the “Asynchronous Structure”, except for some differences for the NAK response.
- For the NAK response in Bulk API calls, no event is created towards the system. The response will contain the failed nodes only. The response will not include the nodes that passed validations.
For example, assume that 200 nodes are received in a request, where 190 passed all validation parameters and 10 failed any validation parameter. The NAK response will contain only the failed 10, each of which with its own error code. The other 190 nodes will not be part of the response.
NOTE: When NAK is returned, the error code category will most probably be GLOBAL_** or AUTH_** only.